Skip to main content
Feedback

Configuring a SOAP operation in an API Service component

In an API Service component, configure a SOAP operation on the SOAP tab.

Before you begin

Open the operation that you would like to configure either by:

  • Creating a new SOAP operation

  • Opening the API Service component, selecting the SOAP tab, and clicking Lock & Edit.

Procedure

  1. Operation Name: Set the operation’s Operation name.

  2. Operation Description: Provide a description for the operation.

  3. Request Handled by Process: If a Web Services Server listener process is not already linked to the endpoint, select the process you want to link from the drop-down menu.

    The Request Handled by Process field populates, along with the default settings for the endpoint’s specified operation. The default settings are derived from the Web Services Server listener operation used in that process.

    note

    In steps 4–9 you can override the default settings derived from the linked process for the endpoint’s specified operation. Refer to the topic about the SOAP tab for information about the settings.

  4. Expected Input Type: Set an override for the operation’s expected input type.

  5. Request Profile: Set an override for the operation’s Request Profile. This is an option only for an operation with its Requested Input Type set to Single XML Object or Multiple XML Objects.

    If you set an override, the profile’s name will appear in black.

  6. Response Output Type: Set an override for the operation’s Response Output Type.

  7. Response Profile: Set an override for the operation’s Response Profile. This is an option only for an operation with its Response Output Type set to Single XML Object or Multiple XML Objects.

    If you set an override, the profile’s name will appear in black.

  8. Maximum Number of Documents Returned: Set an override for the operation’s output Page Size. This is an option only for an operation with its Response Output Type set to Multiple XML Objects.

  9. If SOAP Envelope Passthrough is selected on the SOAP tab, select the Returns a SOAP Fault option to use the value specified in the Dynamic Document Property as the HTTP status code.

  10. Click OK to save.

On this Page